STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

H.?? StructureDefinition: HSPC-Patient

The official URL for this profile is:

http://hl7.org/fhir/StructureDefinition/hspc-patient

The HSPC Patient profile. The demographics and attributes for an individual receiving health care.

This profile was published on Mon, Apr 6, 2015 00:00+1000 as a draft by HSPC.

H.??.1 Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from QICore-Patient.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*Patient
... militaryService Binding: HSPC Veteran Military Status (preferred)
... patient-clinicalTrial 0..0
... patient-birthTime 0..0
... gender 0..1code
... deceasedBoolean 0..1boolean
... address 0..*Address
.... type 0..1code
.... hspc-extensionsprimaryIndicator 0..1CodeableConceptA flag indicating prime
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionsprimaryIndicator
Binding: v2 Yes/no Indicator (preferred)
... multipleBirthBoolean 0..1boolean
... contact BackboneElementSlice: Ordered, Open At End, by patient.contact.relationship
... contact 0..1BackboneElement
.... relationship 0..1CodeableConceptFixed Value: {"coding":[{"system":"http://hl7.org/fhir/ValueSet/patient-contact-relationship","code":"emergency","display":"Emergency"}]}
.... hspc-patient-ContactPartyId 0..1IdentifierExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-patient-ContactPartyId
... communication 0..*BackboneElement
.... hspc-extensionscommunicationMode 0..1CodeableConceptCommunicationMode
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionscommunicationMode
Binding: HSPC Communication Mode (preferred)
... hspc-extensionsbirthDateVerificationMethod 0..1CodeableConceptVerification Method
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionsbirthDateVerificationMethod
Binding: HSPC Verification Method Value Set (preferred)
... hspc-extensionspatientImportance 0..1CodeableConceptThe patient importance
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionspatientImportance
Binding: HSPC VIP Level (preferred)
... hspc-extensionsdeceasedDateTime 0..1dateTimeDeceased DateTime
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionsdeceasedDateTime
... hspc-extensionsmultipleBirthOrderNumber 0..1integerBirth Order Number
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionsmultipleBirthOrderNumber
... hspc-extensionscitezenship 0..*CodeableConceptCitezenship
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionscitezenship
Binding: ISO Country Codes (required)
.... hspc-extensionscitezenshipPeriod 0..1PeriodCitezenship Period
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionscitezenshipPeriod
... hspc-extensionsadoptionInfo 0..1CodeableConceptAdoption Info
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionsadoptionInfo
Binding: HSPC Adoption Info (preferred)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... us-core-race S0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/us-core-race
Binding: MU Race Value Set (preferred)
... us-core-ethnicity S0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/us-core-ethnicity
Binding: Ethnicity group (preferred)
... us-core-religion 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/us-core-religion
Binding: v3 Code System ReligiousAffiliation (extensible)
... birthPlace 0..1AddressExtension
URL: http://hl7.org/fhir/StructureDefinition/birthPlace
... patient-disability 0..*CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/patient-disability
Binding: Disability Value Set (preferred)
... patient-nationality 0..*(Complex)Extension
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
... patient-cadavericDonor 0..1booleanExtension
URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor
... qicore-patient-militaryService 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/qicore-patient-militaryService
Binding: Military Service Codes (example)
... patient-clinicalTrial 0..*(Complex)Extension
URL: http://hl7.org/fhir/StructureDefinition/patient-clinicalTrial
... patient-birthTime S0..1dateTimeExtension
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
... hspc-extensionsbirthDateVerificationMethod 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionsbirthDateVerificationMethod
Binding: HSPC Verification Method Value Set (preferred)
... hspc-extensionspatientImportance 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionspatientImportance
Binding: HSPC VIP Level (preferred)
... hspc-extensionsdeceasedDateTime 0..1dateTimeExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionsdeceasedDateTime
... hspc-extensionsmultipleBirthOrderNumber 0..1integerExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionsmultipleBirthOrderNumber
... hspc-extensionscitezenship 0..*CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionscitezenship
Binding: ISO Country Codes (required)
... hspc-extensionsadoptionInfo 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionsadoptionInfo
Binding: HSPC Adoption Info (preferred)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ∑0..*IdentifierAn identifier for this patient
... active ?! S∑0..1booleanWhether this patient's record is in active use
... name ∑0..*HumanNameA name associated with the patient
... telecom ∑0..*ContactPointA contact detail for the individual
.... iso21090-preferred 0..1booleanExtension
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
.... system ∑ I0..1codephone | fax | email | pager | other
Binding: ContactPointSystem (required)
.... value ∑0..1stringThe actual contact point details
.... use ?! ∑0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank ∑0..1positiveIntSpecify preferred order of use (1 = highest)
.... period ∑0..1PeriodTime period when the contact point was/is in use
... gender S ∑0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate S ∑0..1dateThe date of birth for the individual
... deceasedBoolean ?! S∑0..1booleanIndicates if the individual is deceased or not
... address S ∑0..*AddressAddresses for the individual
.... hspc-extensionsprimaryIndicator 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionsprimaryIndicator
Binding: v2 Yes/no Indicator (preferred)
.... use ?! ∑0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example: home
.... type ∑0..1codepostal | physical | both
Binding: AddressType (required)
Example: both
.... text ∑0..1stringText representation of the address
Example: 137 Nowhere Street, Erewhon 9132
.... line ∑0..*stringStreet name, number, direction & P.O. Box etc.
Example: 137 Nowhere Street
.... city ∑0..1stringName of city, town etc.
Example: Erewhon
.... district ∑0..1stringDistrict name (aka county)
Example: Madison
.... state ∑0..1stringSub-unit of country (abbreviations ok)
.... postalCode ∑0..1stringPostal code for area
Example: 9132
.... country ∑0..1stringCountry (can be ISO 3166 3 letter code)
.... period ∑0..1PeriodTime period when address was/is in use
Example: {"start":"2010-03-23","end":"2010-07-01"}
.... iso21090-preferred 0..1booleanExtension
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
.... use ?! ∑0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example: home
.... type ∑0..1codepostal | physical | both
Binding: AddressType (required)
Example: both
.... text ∑0..1stringText representation of the address
Example: 137 Nowhere Street, Erewhon 9132
.... line ∑0..*stringStreet name, number, direction & P.O. Box etc.
Example: 137 Nowhere Street
.... city ∑0..1stringName of city, town etc.
Example: Erewhon
.... district ∑0..1stringDistrict name (aka county)
Example: Madison
.... state ∑0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (preferred)
.... postalCode ∑0..1stringPostal code for area
Example: 9132
.... country ∑0..1stringCountry (can be ISO 3166 3 letter code)
Binding: ISO Country Codes (required)
.... period ∑0..1PeriodTime period when address was/is in use
Example: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (required)
... multipleBirthBoolean 0..1booleanWhether patient is part of a multiple birth
... photo 0..*AttachmentImage of the patient
... contact IBackboneElementA contact party (e.g. guardian, partner, friend) for the patient
Slice: Ordered, Open At End, by patient.contact.relationship
pat-1: SHALL at least contain a contact's details or a reference to an organization
... contact I0..1BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... hspc-patient-ContactPartyId 0..1IdentifierExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-patient-ContactPartyId
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... relationship 0..1CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible)
Fixed Value: {"coding":[{"system":"http://hl7.org/fhir/ValueSet/patient-contact-relationship","code":"emergency","display":"Emergency"}]}
.... name 0..1HumanNameA name associated with the contact person
.... telecom 0..*ContactPointA contact detail for the person
.... address 0..1AddressAddress for the contact person
..... extension 0..*ExtensionAdditional Content defined by implementations
..... use ?! ∑0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example: home
..... type ∑0..1codepostal | physical | both
Binding: AddressType (required)
Example: both
..... text ∑0..1stringText representation of the address
Example: 137 Nowhere Street, Erewhon 9132
..... line ∑0..*stringStreet name, number, direction & P.O. Box etc.
Example: 137 Nowhere Street
..... city ∑0..1stringName of city, town etc.
Example: Erewhon
..... district ∑0..1stringDistrict name (aka county)
Example: Madison
..... state ∑0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (preferred)
..... postalCode ∑0..1stringPostal code for area
Example: 9132
..... country ∑0..1stringCountry (can be ISO 3166 3 letter code)
Binding: ISO Country Codes (required)
..... period ∑0..1PeriodTime period when address was/is in use
Example: {"start":"2010-03-23","end":"2010-07-01"}
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
.... organization I0..1Reference(QICore-Organization)Organization that is associated with the contact
.... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication S0..*BackboneElementA list of Languages which may be used to communicate with the patient about his or her health
.... hspc-extensionscommunicationMode 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionscommunicationMode
Binding: HSPC Communication Mode (preferred)
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: IETF BCP-47 (required)
.... preferred 0..1booleanLanguage preference indicator
... careProvider 0..*Reference(QICore-Organization | QICore-Practitioner)Patient's nominated primary care provider
... managingOrganization ∑0..1Reference(QICore-Organization)Organization that is the custodian of the patient record
... link ?!0..*BackboneElementLink to another patient resource that concerns the same actual person
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... other ?!1..1Reference(QICore-Patient)The other patient resource that the link refers to
.... type ?!1..1codereplace | refer | seealso - type of link
Binding: LinkType (required)

doco Documentation for this format

todo

Differential View

This structure is derived from QICore-Patient.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*Patient
... militaryService Binding: HSPC Veteran Military Status (preferred)
... patient-clinicalTrial 0..0
... patient-birthTime 0..0
... gender 0..1code
... deceasedBoolean 0..1boolean
... address 0..*Address
.... type 0..1code
.... hspc-extensionsprimaryIndicator 0..1CodeableConceptA flag indicating prime
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionsprimaryIndicator
Binding: v2 Yes/no Indicator (preferred)
... multipleBirthBoolean 0..1boolean
... contact BackboneElementSlice: Ordered, Open At End, by patient.contact.relationship
... contact 0..1BackboneElement
.... relationship 0..1CodeableConceptFixed Value: {"coding":[{"system":"http://hl7.org/fhir/ValueSet/patient-contact-relationship","code":"emergency","display":"Emergency"}]}
.... hspc-patient-ContactPartyId 0..1IdentifierExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-patient-ContactPartyId
... communication 0..*BackboneElement
.... hspc-extensionscommunicationMode 0..1CodeableConceptCommunicationMode
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionscommunicationMode
Binding: HSPC Communication Mode (preferred)
... hspc-extensionsbirthDateVerificationMethod 0..1CodeableConceptVerification Method
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionsbirthDateVerificationMethod
Binding: HSPC Verification Method Value Set (preferred)
... hspc-extensionspatientImportance 0..1CodeableConceptThe patient importance
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionspatientImportance
Binding: HSPC VIP Level (preferred)
... hspc-extensionsdeceasedDateTime 0..1dateTimeDeceased DateTime
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionsdeceasedDateTime
... hspc-extensionsmultipleBirthOrderNumber 0..1integerBirth Order Number
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionsmultipleBirthOrderNumber
... hspc-extensionscitezenship 0..*CodeableConceptCitezenship
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionscitezenship
Binding: ISO Country Codes (required)
.... hspc-extensionscitezenshipPeriod 0..1PeriodCitezenship Period
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionscitezenshipPeriod
... hspc-extensionsadoptionInfo 0..1CodeableConceptAdoption Info
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionsadoptionInfo
Binding: HSPC Adoption Info (preferred)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... us-core-race S0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/us-core-race
Binding: MU Race Value Set (preferred)
... us-core-ethnicity S0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/us-core-ethnicity
Binding: Ethnicity group (preferred)
... us-core-religion 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/us-core-religion
Binding: v3 Code System ReligiousAffiliation (extensible)
... birthPlace 0..1AddressExtension
URL: http://hl7.org/fhir/StructureDefinition/birthPlace
... patient-disability 0..*CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/patient-disability
Binding: Disability Value Set (preferred)
... patient-nationality 0..*(Complex)Extension
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
... patient-cadavericDonor 0..1booleanExtension
URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor
... qicore-patient-militaryService 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/qicore-patient-militaryService
Binding: Military Service Codes (example)
... patient-clinicalTrial 0..*(Complex)Extension
URL: http://hl7.org/fhir/StructureDefinition/patient-clinicalTrial
... patient-birthTime S0..1dateTimeExtension
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
... hspc-extensionsbirthDateVerificationMethod 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionsbirthDateVerificationMethod
Binding: HSPC Verification Method Value Set (preferred)
... hspc-extensionspatientImportance 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionspatientImportance
Binding: HSPC VIP Level (preferred)
... hspc-extensionsdeceasedDateTime 0..1dateTimeExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionsdeceasedDateTime
... hspc-extensionsmultipleBirthOrderNumber 0..1integerExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionsmultipleBirthOrderNumber
... hspc-extensionscitezenship 0..*CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionscitezenship
Binding: ISO Country Codes (required)
... hspc-extensionsadoptionInfo 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionsadoptionInfo
Binding: HSPC Adoption Info (preferred)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ∑0..*IdentifierAn identifier for this patient
... active ?! S∑0..1booleanWhether this patient's record is in active use
... name ∑0..*HumanNameA name associated with the patient
... telecom ∑0..*ContactPointA contact detail for the individual
.... iso21090-preferred 0..1booleanExtension
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
.... system ∑ I0..1codephone | fax | email | pager | other
Binding: ContactPointSystem (required)
.... value ∑0..1stringThe actual contact point details
.... use ?! ∑0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank ∑0..1positiveIntSpecify preferred order of use (1 = highest)
.... period ∑0..1PeriodTime period when the contact point was/is in use
... gender S ∑0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate S ∑0..1dateThe date of birth for the individual
... deceasedBoolean ?! S∑0..1booleanIndicates if the individual is deceased or not
... address S ∑0..*AddressAddresses for the individual
.... hspc-extensionsprimaryIndicator 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionsprimaryIndicator
Binding: v2 Yes/no Indicator (preferred)
.... use ?! ∑0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example: home
.... type ∑0..1codepostal | physical | both
Binding: AddressType (required)
Example: both
.... text ∑0..1stringText representation of the address
Example: 137 Nowhere Street, Erewhon 9132
.... line ∑0..*stringStreet name, number, direction & P.O. Box etc.
Example: 137 Nowhere Street
.... city ∑0..1stringName of city, town etc.
Example: Erewhon
.... district ∑0..1stringDistrict name (aka county)
Example: Madison
.... state ∑0..1stringSub-unit of country (abbreviations ok)
.... postalCode ∑0..1stringPostal code for area
Example: 9132
.... country ∑0..1stringCountry (can be ISO 3166 3 letter code)
.... period ∑0..1PeriodTime period when address was/is in use
Example: {"start":"2010-03-23","end":"2010-07-01"}
.... iso21090-preferred 0..1booleanExtension
URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred
.... use ?! ∑0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example: home
.... type ∑0..1codepostal | physical | both
Binding: AddressType (required)
Example: both
.... text ∑0..1stringText representation of the address
Example: 137 Nowhere Street, Erewhon 9132
.... line ∑0..*stringStreet name, number, direction & P.O. Box etc.
Example: 137 Nowhere Street
.... city ∑0..1stringName of city, town etc.
Example: Erewhon
.... district ∑0..1stringDistrict name (aka county)
Example: Madison
.... state ∑0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (preferred)
.... postalCode ∑0..1stringPostal code for area
Example: 9132
.... country ∑0..1stringCountry (can be ISO 3166 3 letter code)
Binding: ISO Country Codes (required)
.... period ∑0..1PeriodTime period when address was/is in use
Example: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (required)
... multipleBirthBoolean 0..1booleanWhether patient is part of a multiple birth
... photo 0..*AttachmentImage of the patient
... contact IBackboneElementA contact party (e.g. guardian, partner, friend) for the patient
Slice: Ordered, Open At End, by patient.contact.relationship
pat-1: SHALL at least contain a contact's details or a reference to an organization
... contact I0..1BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... hspc-patient-ContactPartyId 0..1IdentifierExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-patient-ContactPartyId
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... relationship 0..1CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible)
Fixed Value: {"coding":[{"system":"http://hl7.org/fhir/ValueSet/patient-contact-relationship","code":"emergency","display":"Emergency"}]}
.... name 0..1HumanNameA name associated with the contact person
.... telecom 0..*ContactPointA contact detail for the person
.... address 0..1AddressAddress for the contact person
..... extension 0..*ExtensionAdditional Content defined by implementations
..... use ?! ∑0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example: home
..... type ∑0..1codepostal | physical | both
Binding: AddressType (required)
Example: both
..... text ∑0..1stringText representation of the address
Example: 137 Nowhere Street, Erewhon 9132
..... line ∑0..*stringStreet name, number, direction & P.O. Box etc.
Example: 137 Nowhere Street
..... city ∑0..1stringName of city, town etc.
Example: Erewhon
..... district ∑0..1stringDistrict name (aka county)
Example: Madison
..... state ∑0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (preferred)
..... postalCode ∑0..1stringPostal code for area
Example: 9132
..... country ∑0..1stringCountry (can be ISO 3166 3 letter code)
Binding: ISO Country Codes (required)
..... period ∑0..1PeriodTime period when address was/is in use
Example: {"start":"2010-03-23","end":"2010-07-01"}
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
.... organization I0..1Reference(QICore-Organization)Organization that is associated with the contact
.... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication S0..*BackboneElementA list of Languages which may be used to communicate with the patient about his or her health
.... hspc-extensionscommunicationMode 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionscommunicationMode
Binding: HSPC Communication Mode (preferred)
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: IETF BCP-47 (required)
.... preferred 0..1booleanLanguage preference indicator
... careProvider 0..*Reference(QICore-Organization | QICore-Practitioner)Patient's nominated primary care provider
... managingOrganization ∑0..1Reference(QICore-Organization)Organization that is the custodian of the patient record
... link ?!0..*BackboneElementLink to another patient resource that concerns the same actual person
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... other ?!1..1Reference(QICore-Patient)The other patient resource that the link refers to
.... type ?!1..1codereplace | refer | seealso - type of link
Binding: LinkType (required)

doco Documentation for this format

XML Template

JSON Template

todo

 

Other representations of profile: Schematron

H.??.2 Terminology Bindings

PathNameConformanceValueSet
Patient.language?extrequiredhttp://tools.ietf.org/html/bcp47
Patient.extension
[UriType[http://hl7.org/fhir/StructureDefinition/us-core-race]]
MU Race Value SetpreferredMU Race Value Set
Patient.extension
[UriType[http://hl7.org/fhir/StructureDefinition/us-core-ethnicity]]
Ethnicity grouppreferredEthnicity group
Patient.extension
[UriType[http://hl7.org/fhir/StructureDefinition/us-core-religion]]
v3 Code System ReligiousAffiliationextensiblev3 Code System ReligiousAffiliation
Patient.extension
[UriType[http://hl7.org/fhir/StructureDefinition/patient-disability]]
Disability Value SetpreferredDisability Value Set
Patient.extension
[UriType[http://hl7.org/fhir/StructureDefinition/qicore-patient-militaryService]]
Military Service CodesexampleMilitary Service Codes
Patient.extension
[UriType[http://hl7.org/fhir/StructureDefinition/hspc-extensionsbirthDateVerificationMethod]]
HSPC Verification Method Value SetpreferredHSPC Verification Method Value Set
Patient.extension
[UriType[http://hl7.org/fhir/StructureDefinition/hspc-extensionspatientImportance]]
HSPC VIP LevelpreferredHSPC VIP Level
Patient.extension
[UriType[http://hl7.org/fhir/StructureDefinition/hspc-extensionscitezenship]]
?extrequiredhttp://www.iso.org/iso/country_codes.htm
Patient.extension
[UriType[http://hl7.org/fhir/StructureDefinition/hspc-extensionsadoptionInfo]]
HSPC Adoption InfopreferredHSPC Adoption Info
Patient.telecom.systemContactPointSystemrequiredContactPointSystem
Patient.telecom.useContactPointUserequiredContactPointUse
Patient.genderAdministrativeGenderrequiredAdministrativeGender
Patient.address.extension
[UriType[http://hl7.org/fhir/StructureDefinition/hspc-extensionsprimaryIndicator]]
v2 Yes/no Indicatorpreferredv2 Yes/no Indicator
Patient.address.useAddressUserequiredAddressUse
Patient.address.typeAddressTyperequiredAddressType
Patient.address.useAddressUserequiredAddressUse
Patient.address.typeAddressTyperequiredAddressType
Patient.address.stateUSPS Two Letter Alphabetic CodespreferredUSPS Two Letter Alphabetic Codes
Patient.address.country?extrequiredhttp://www.iso.org/iso/country_codes.htm
Patient.maritalStatusMarital Status CodesrequiredMarital Status Codes
Patient.contact.relationshipPatientContactRelationshipextensiblePatientContactRelationship
Patient.contact.address.useAddressUserequiredAddressUse
Patient.contact.address.typeAddressTyperequiredAddressType
Patient.contact.address.stateUSPS Two Letter Alphabetic CodespreferredUSPS Two Letter Alphabetic Codes
Patient.contact.address.country?extrequiredhttp://www.iso.org/iso/country_codes.htm
Patient.contact.genderAdministrativeGenderrequiredAdministrativeGender
Patient.animal.speciesAnimalSpeciesexampleAnimalSpecies
Patient.animal.breedAnimalBreedsexampleAnimalBreeds
Patient.animal.genderStatusGenderStatusexampleGenderStatus
Patient.communication.extension
[UriType[http://hl7.org/fhir/StructureDefinition/hspc-extensionscommunicationMode]]
HSPC Communication ModepreferredHSPC Communication Mode
Patient.communication.language?extrequiredhttp://tools.ietf.org/html/bcp47
Patient.link.typeLinkTyperequiredLinkType

H.??.3 Constraints

IdPathDetailsRequirements
pat-1Patient.contactSHALL at least contain a contact's details or a reference to an organization
XPath: f:name or f:telecom or f:address or f:organization
pat-1Patient.contactSHALL at least contain a contact's details or a reference to an organization
XPath: f:name or f:telecom or f:address or f:organization
.